Sample Request
{
"Package": {
"Content": {
"Application": {
"PersonApplicant": [
{
"@x_Household": "fa86c8054f4c"
}
],
"Household": [{
"Dependant": [{
"@Age": "99",
"@DateOfBirth": "2023-02-08",
"@Name: "John Doe",
"@UniqueID": "eb4f68665745"
}],
"ExpenseDetails": {
"LivingExpense": [
{
"@Category": "Childcare",
"@Amount": "123.23",
"@Frequency": "Monthly",
"@UniqueID": "eb4f68665745"
},
{
"@Category": "Clothing and personal care",
"@Amount": "100",
"@Frequency": "Monthly",
"@UniqueID": "eb4f68665745"
},
{
"@Category": "Groceries",
"@Amount": "100",
"@Frequency": "Monthly",
"@UniqueID": "eb4f68665745"
},
{
"@Category": "Medical and health",
"@Amount": "100",
"@Frequency": "Monthly",
"@UniqueID": "eb4f68665745"
},
{
"@Category": "Other",
"@Amount": "100",
"@Frequency": "Monthly",
"@UniqueID": "eb4f68665745"
},
{
"@Category": "Recreation and entertainment",
"@Amount": "100",
"@Frequency": "Monthly",
"@UniqueID": "eb4f68665745"
},
{
"@Category": "Telephone, internet, pay TV and media streaming subscriptions",
"@Amount": "100",
"@Frequency": "Monthly",
"@UniqueID": "eb4f68665745"
}
],
"OtherCommitment": [
{
"@Category": "Rent",
"@Amount": "400.10",
"@Frequency": "Monthly",
"@UniqueID": "eb4f68665745"
}
]
},
"@Name": "Abbott Household",
"@NumberOfAdults": "1",
"@NumberOfDependants": "1",
"@SequenceNumber": "0",
"@UniqueID": "fa86c8054f4c"
}]
}
}
}
}
Detailed description of each field:
| Field Name | Description | Type | Path | Required | Enumerations | Note |
|---|
| PersonApplicant | Contains applicant details where the applicant is a person, being either a borrower or a guarantor, and may be acting for a Trust | object | Package.Content.Application.PersonApplicant | | | |
| @x_Household | Links to a Household element | string | Package.Content.Application.PersonApplicant.x_Household | Yes | | |
| Household | A household to which one or more person applicants belong, used in relation to the calculation of household living expenses | array | Package.Content.Application.Household | | | |
| @Name | A descriptive name for the household | string | Package.Content.Application.Household.Name | Yes | | |
| @NumberOfAdults | The number of adults in the household | integer | Package.Content.Application.Household.NumberOfAdults | Yes | | |
| @NumberOfDependants | The number of dependants in this applicant household | integer | Package.Content.Application.Household.NumberOfDependants | Yes | | |
| @UniqueID | Unique identification for the household | string | Package.Content.Application.Household.UniqueID | Yes | | |
| ExpenseDetails | The set of expenses declared for the household, including Living Expenses and Other Commitments | object | Package.Content.Application.Household.ExpenseDetails | | | |
| LivingExpense | Contains the details of a single line item that forms part of the household's declared living expenses | object | Package.Content.Application.Household.ExpenseDetails.LivingExpense | | | |
| @Amount | The dollar amount of this particular living expense for the household as declared by the applicant | number | Package.Content.Application.Household.ExpenseDetails.LivingExpense.Amount | Yes | | Mandatory if Living Expenses exists |
| @Category | The category that this declared living expense falls under | string | Package.Content.Application.Household.ExpenseDetails.LivingExpense.Category | Yes | Groceries, Childcare, Public or Government Primary and Secondary Education, Clothing and Personal Care, Telephone Internet Pay TV Media Streaming Subscriptions, General Basic Insurance, Medical And Health, Transport, Recreation And Entertainment, Primary Residence Running Costs, Investment Property Running Costs, Other Living Expenses, Rent, Child And Spousal Maintenance, Other Commitments | Mandatory if Living Expenses exists |
| @Frequency | The frequency that corresponds to the declared amount for this particular Living Expense | string | Package.Content.Application.Household.ExpenseDetails.LivingExpense.Frequency | Yes | Daily, Fortnightly, Half Yearly, Monthly, Quarterly, Weekly, Yearly | Mandatory only if Living Expense Amount is not null |
| @UniqueID | Unique Identifier for this living expens | string | Package.Content.Application.Household.ExpenseDetails.LivingExpense.UniqueID | | | |
| OtherCommitment | Contains the details of a single line item that forms part of the household's commitments other than living expenses | object | Package.Content.Application.Household.ExpenseDetails.OtherCommitment | | | |
| @Amount | The dollar amount of this particular commitment for the household as declared by the applicant | number | Package.Content.Application.Household.ExpenseDetails.OtherCommitment.Amount | Yes | | Mandatory if Other Commitment exists |
| @Category | The category that this declared other commitment falls under | string | Package.Content.Application.Household.ExpenseDetails.OtherCommitment.Category | Yes | | Mandatory if Other Commitment exists |
| @Frequency | The frequency that corresponds to the declared amount for this particular commitment | string | Package.Content.Application.Household.ExpenseDetails.OtherCommitment.Frequency | Yes | Daily, Fortnightly, Half Yearly, Monthly, Quarterly, Weekly, Yearly | Mandatory if Other Commitment Amount is not null |
| @UniqueID | Unique Identifier for this commitment | string | Package.Content.Application.Household.ExpenseDetails.OtherCommitment.UniqueID | | |